/*
 * Copyright (c) 2023, Nordic Semiconductor
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without modification, are
 * permitted provided that the following conditions are met:
 *
 * 1. Redistributions of source code must retain the above copyright notice, this list of
 * conditions and the following disclaimer.
 *
 * 2. Redistributions in binary form must reproduce the above copyright notice, this list
 * of conditions and the following disclaimer in the documentation and/or other materials
 * provided with the distribution.
 *
 * 3. Neither the name of the copyright holder nor the names of its contributors may be
 * used to endorse or promote products derived from this software without specific prior
 * written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
 * PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
 * HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA,
 * OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
 * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
 * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
 * EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */

package no.nordicsemi.android.kotlin.ble.server.main.service

import kotlinx.coroutines.CoroutineScope
import no.nordicsemi.android.kotlin.ble.core.ClientDevice
import no.nordicsemi.android.kotlin.ble.core.data.BleGattPhy
import no.nordicsemi.android.kotlin.ble.core.data.PhyOption
import no.nordicsemi.android.kotlin.ble.core.provider.ConnectionProvider
import no.nordicsemi.android.kotlin.ble.server.api.GattServerAPI

/**
 * Class wrapping properties of BLE connection between server and it's client device.
 *
 * @property device A client device
 * @property server A server API instance unique per server. It is shared between all connected devices.
 * @property services Cloned services separate for this connection.
 * @property connectionProvider MTU provider for this connection.
 * @property txPhy Transmitter PHY value.
 * @property rxPhy Receiver PHY value.
 */
@Suppress("unused")
data class ServerBluetoothGattConnection internal constructor(
    val device: ClientDevice,
    private val server: GattServerAPI,
    val connectionScope: CoroutineScope,
    val services: ServerBleGattServices,
    val connectionProvider: ConnectionProvider,
    val txPhy: BleGattPhy? = null,
    val rxPhy: BleGattPhy? = null
) {

    /**
     * Request reading PHY values for this connection.
     */
    fun readPhy() {
        server.readPhy(device)
    }

    /**
     * Request new PHY values for this connectino.
     *
     * @param txPhy Transmitter PHY value.
     * @param rxPhy Receiver PHY value.
     * @param phyOption PHY option.
     */
    fun requestPhy(txPhy: BleGattPhy, rxPhy: BleGattPhy, phyOption: PhyOption) {
        server.requestPhy(device, txPhy, rxPhy, phyOption)
    }
}
